\

__()

__(  $str) : string

Translate a string.

Parameters

Returns

Translated string.

_GeoIP_seek_country()

_GeoIP_seek_country(  $gi,   $ipnum) 

Parameters

_get_org()

_get_org(  $gi,   $ipnum) 

Parameters

_get_region()

_get_region(  $gi,   $ipnum) 

Parameters

_n()

_n(  $sing,   $plur,   $n) : string

Translate the plural form of a string.

Parameters

Returns

Translated string.

_setup_segments()

_setup_segments(  $gi) 

Parameters

Assort_Shortcuts_GetTagByNameOr404()

Assort_Shortcuts_GetTagByNameOr404(string  $name) : \Assort_Tag

Returns Assort_Tag with given name.

Throws an exception (with http code 404) if there is no tag with given name.

Parameters

Throws

\Assort_Exception_ObjectNotFound

if there is no tag with given name.

Returns

Assort_Shortcuts_NormalizeItemPerPage()

Assort_Shortcuts_NormalizeItemPerPage(  $request) 

Parameters

Bank_Shortcuts_ConvertCurrency()

Bank_Shortcuts_ConvertCurrency(\number  $amount, string  $fromCurrency, string  $toCurrency) : \number

Convert given value from given currency and returns the new amount in the $toCurrency if pissible elese throws an exception.

Parameters

Throws

\Pluf_Exception_BadRequest

Returns

Bank_Shortcuts_GetBankOr404()

Bank_Shortcuts_GetBankOr404(\number  $id) : \Bank_Backend

Parameters

Throws

\Pluf_HTTP_Error404

Returns

Bank_Shortcuts_GetEngineOr404()

Bank_Shortcuts_GetEngineOr404(string  $type) : \Bank_Engine

یک موتور پرداخت را پیدا می‌کند.

Parameters

Throws

\Bank_Exception_EngineNotFound

Returns

Bank_Shortcuts_GetReceiptOr404()

Bank_Shortcuts_GetReceiptOr404(\number  $id) : \Bank_Receipt

Parameters

Throws

\Pluf_HTTP_Error404

Returns

Bank_Shortcuts_IsCurrenciesCompatible()

Bank_Shortcuts_IsCurrenciesCompatible(string  $currency1, string  $currency2) : boolean

Checks if given currencies are compatible.

Two currencies are compatible if both are same or one is 'IRR' and other is 'IRT'.

Parameters

Returns

Bank_Shortcuts_receiptFactory()

Bank_Shortcuts_receiptFactory(\Bank_Receipt  $object) : \Bank_Receipt

یک نمونه جدید از پرداخت ایجاد می‌کند

در صورتی که پیش از این نمونه‌ای برای پرداخت ایجاد شده باشد آن را به عنوان نتیجه برمی‌گرداند.

Parameters

Returns

CMS_Shortcuts_CleanName()

CMS_Shortcuts_CleanName(string  $name) : string

یک نام جدید را بررسی می‌کند.

نام یک محتوی باید در یک ملک به صورت انحصاری تعیین شود. بنابر این روال بررسی می‌کند که آیا محتویی هم نام با نام در نظر گرفته شده در ملک وجود دارد یا نه.

این فراخوانی در فرم‌ها کاربرد دارد.

Parameters

Throws

\Pluf\Exception

Returns

CMS_Shortcuts_GetNamedContentOr404()

CMS_Shortcuts_GetNamedContentOr404(string  $name) : \ArrayObject

Get content based on name

Parameters

Throws

\CMS_Exception_ObjectNotFound

Returns

CMS_Shortcuts_GetTermBySlugOr404()

CMS_Shortcuts_GetTermBySlugOr404(string  $slug) : \CMS_Term

Get term by its slug

Parameters

Throws

\CMS_Exception_ObjectNotFound

Returns

Collection_Shortcuts_GetCollectionByName()

Collection_Shortcuts_GetCollectionByName(string  $name) : \Collection_Collection|NULL

Returns collection with given name and returns null if there is no collection with given name.

Parameters

Returns

Collection_Shortcuts_GetCollectionByNameOr404()

Collection_Shortcuts_GetCollectionByNameOr404(string  $name) : \Collection_Collection

Returns collection with given name or throws 404 not found exception if such collection does not exist.

Parameters

Throws

\Pluf_Exception_DoesNotExist

Returns

Collection_Shortcuts_NormalizeItemPerPage()

Collection_Shortcuts_NormalizeItemPerPage(  $request) 

Parameters

Discount_Shortcuts_GetDiscountByCodeOr404()

Discount_Shortcuts_GetDiscountByCodeOr404(string  $code) : \Discount_Discount

Returns discount with given code or throws exception if such discount does not exist.

Parameters

Throws

\Discount_Exception_ObjectNotFound

Returns

Discount_Shortcuts_GetDiscountByCodeOrNull()

Discount_Shortcuts_GetDiscountByCodeOrNull(string  $code) : \Discount_Discount|NULL

Returns discount with given code or null if such discount does not exist.

Parameters

Returns

Discount_Shortcuts_GetEngineOr404()

Discount_Shortcuts_GetEngineOr404(string  $type) : \Discount_Engine

یک متور پرداخت را پیدا می‌کند.

Parameters

Throws

\Discount_Exception_EngineNotFound

Returns

Discount_Shortcuts_GetEngineOrNull()

Discount_Shortcuts_GetEngineOrNull(string  $type) : \Discount_Engine

Parameters

Returns

| NULL

Discount_Shortcuts_NormalizeItemPerPage()

Discount_Shortcuts_NormalizeItemPerPage(  $request) 

Parameters

DM_Shortcuts_GetAccountOr404()

DM_Shortcuts_GetAccountOr404(  $id) 

Parameters

DM_Shortcuts_GetAssetOr404()

DM_Shortcuts_GetAssetOr404(  $id) 

Parameters

DM_Shortcuts_GetLinkBySecureIdOr404()

DM_Shortcuts_GetLinkBySecureIdOr404(  $secure_id) 

Parameters

DM_Shortcuts_GetLinkOr404()

DM_Shortcuts_GetLinkOr404(  $id) 

Parameters

DM_Shortcuts_GetPlanOr404()

DM_Shortcuts_GetPlanOr404(  $id) 

Parameters

DM_Shortcuts_GetPlanTemplateOr404()

DM_Shortcuts_GetPlanTemplateOr404(  $id) 

Parameters

ELearn_Shortcuts_CleanName()

ELearn_Shortcuts_CleanName(string  $name) : string

یک نام جدید را بررسی می‌کند.

نام یک محتوی باید در یک ملک به صورت انحصاری تعیین شود. بنابر این روال بررسی می‌کند که آیا محتویی هم نام با نام در نظر گرفته شده در ملک وجود دارد یا نه.

این فراخوانی در فرم‌ها کاربرد دارد.

Parameters

Throws

\Pluf_Exception

Returns

ELearn_Shortcuts_FindAll()

ELearn_Shortcuts_FindAll(\Pluf_Model  $model, array  $filter, array  $sort) : array

Parameters

Returns

ELearn_Shortcuts_GetPartByNameOr404()

ELearn_Shortcuts_GetPartByNameOr404(string  $name) : \ArrayObject

Get content based on name

Parameters

Throws

\CMS_Exception_ObjectNotFound

Returns

ELearn_Shortcuts_GetTopicsByTitle()

ELearn_Shortcuts_GetTopicsByTitle(string  $title) : \ArrayObject

Parameters

Returns

of items or through an exception if database failure

ELearn_Shortcuts_NormalizeItemPerPage()

ELearn_Shortcuts_NormalizeItemPerPage(  $request) 

Parameters

Exchange_Shortcuts_NormalizeItemPerPage()

Exchange_Shortcuts_NormalizeItemPerPage(  $request) 

Parameters

Geo_DB_GeometryFromDb()

Geo_DB_GeometryFromDb(\unknown  $val) : string

Parameters

Returns

Geo_DB_GeometryToDb()

Geo_DB_GeometryToDb(\unknown  $val, \unknown  $db) : string

Convert text to geometry

Parameters

Returns

Geo_DB_PointToDb()

Geo_DB_PointToDb(\unknown  $val, \unknown  $db) : string

Parameters

Returns

Geo_DB_PolygonToDb()

Geo_DB_PolygonToDb(\unknown  $val, \unknown  $db) : string

Convert text to geometry

Parameters

Returns

Geo_Shortcuts_GetLocationOr404()

Geo_Shortcuts_GetLocationOr404(\unknown  $id) 

Parameters

Throws

\Pluf_HTTP_Error404

Geo_Shortcuts_locationBound()

Geo_Shortcuts_locationBound(\unknown  $request, \unknown  $lat, \unknown  $long, \unknown  $meters = 1000) : \number

بیشترین و کمترین مقدار در نقاط جستجو را تعیین می‌کند.

Parameters

Returns

Geo_Shortcuts_locationCount()

Geo_Shortcuts_locationCount(\unknown  $request) : \number

بر اساس سطح دسترسی کاربر تعداد مکان‌های قابل دسترسی را تعیین می‌کند.

Parameters

Returns

Geo_Shortcuts_locationFactory()

Geo_Shortcuts_locationFactory(\unknown  $object) : \User

مدل داده‌ای مکان را ایجاد می‌کند.

Parameters

Returns

Geo_Shortcuts_locationRadios()

Geo_Shortcuts_locationRadios(\unknown  $request, \number  $radius = 1000) 

محدوده جستجو را تعیین می‌کند.

Parameters

GeoIP_close()

GeoIP_close(  $gi) 

Parameters

GeoIP_country_code_by_addr()

GeoIP_country_code_by_addr(  $gi,   $addr) 

Parameters

GeoIP_country_code_by_name()

GeoIP_country_code_by_name(  $gi,   $name) 

Parameters

GeoIP_country_id_by_addr()

GeoIP_country_id_by_addr(  $gi,   $addr) 

Parameters

GeoIP_country_id_by_name()

GeoIP_country_id_by_name(  $gi,   $name) 

Parameters

GeoIP_country_name_by_addr()

GeoIP_country_name_by_addr(  $gi,   $addr) 

Parameters

GeoIP_country_name_by_name()

GeoIP_country_name_by_name(  $gi,   $name) 

Parameters

GeoIP_countryOfRequest()

GeoIP_countryOfRequest(  $request,   $geoipdb) : string

Return the 2 character code of the country given the request object.

Parameters

Returns

2 character ISO code

GeoIP_getdnsattributes()

GeoIP_getdnsattributes(  $l,   $ip) 

Parameters

GeoIP_load_shared_mem()

GeoIP_load_shared_mem(  $file) 

Parameters

GeoIP_open()

GeoIP_open(  $filename,   $flags) 

Parameters

GeoIP_org_by_addr()

GeoIP_org_by_addr(  $gi,   $addr) 

Parameters

GeoIP_region_by_addr()

GeoIP_region_by_addr(  $gi,   $addr) 

Parameters

Marketplace_Shortcuts_GetSpaOr404ByName()

Marketplace_Shortcuts_GetSpaOr404ByName(String  $name) : \Marketplace_Spa

Get Spa

Parameters

Throws

\Pluf_HTTP_Error404

Returns

Marketplace_Shortcuts_SpaManager()

Marketplace_Shortcuts_SpaManager(\Marketplace_Spa  $spa) : \Marketplace_Spa_Manager_Simple

Parameters

Returns

Marketplace_Shortcuts_SpaUpdate()

Marketplace_Shortcuts_SpaUpdate(\Pluf_HTTP_Request  $request, \Marketplace_Spa  $spa) 

Parameters

Marketplace_Template_Shortcuts_update()

Marketplace_Template_Shortcuts_update(\Pluf_HTTP_Request  $request,   $template) 

Parameters

mb_ucfirst()

mb_ucfirst(  $str) 

Parameters

Monitor_Shortcuts_convertMetricToPrometheusLabel()

Monitor_Shortcuts_convertMetricToPrometheusLabel(  $bean) 

Creates bean property label

Parameters

Monitor_Shortcuts_convertMetricToResponse()

Monitor_Shortcuts_convertMetricToResponse(  $request,   $match,   $metric) 

Parameters

Monitor_Shortcuts_convertPageOfMetricsToResponse()

Monitor_Shortcuts_convertPageOfMetricsToResponse(  $request,   $match,   $page) 

Converts page to response

Parameters

Monitor_Shortcuts_isPrometheusRequest()

Monitor_Shortcuts_isPrometheusRequest(  $request) 

Parameters

Newspaper_Shortcuts_GetFollowerListCount()

Newspaper_Shortcuts_GetFollowerListCount(  $request) 

Parameters

Newspaper_Shortcuts_GetFollowerOr404()

Newspaper_Shortcuts_GetFollowerOr404(  $id) : \Newspaper_Follower

دنبال‌کننده تعیین شده با شناسه را پیدا می‌کند.

در صورتی که دنبال‌کننده پیدا نشود خطا ۴۰۴ به عنوان نتیجه تولید و منتشر خواهد شد.

Parameters

Throws

\Newspaper_Exception_FollowerNotFound

Returns

دنبال‌کننده‌ای که پیدا شده است.

Notifier_Shortcuts_GetEngineOr404()

Notifier_Shortcuts_GetEngineOr404(string  $type) : \Notifier_Engine

Finds a notification engine

Parameters

Throws

\Notifier_Exception_EngineNotFound

Returns

Pluf_autoload()

Pluf_autoload(  $class_name) 

Autoload function.

Parameters

Pluf_Date_Compare()

Pluf_Date_Compare(  $date1,   $date2 = null) : integer

مقایسه دو تاریخ با یکدیگر

Compare two date and returns the number of seconds between the first and the second. If only the date is given without time, the end of the day is used (23:59:59).

Parameters

Returns

Number of seconds between the two dates. Negative value if the second date is before the first.

Pluf_Date_Easy()

Pluf_Date_Easy(  $date,   $ref = null,   $blocks = 2,   $notime = 'now',   $show = true) : string

نمایش تاریخ به فرمت دلخواه

Display a date in the format: X days Y hours ago X hours Y minutes ago X hours Y minutes left

"resolution" is year, month, day, hour, minute.

If not time is given, only the day, the end of the day is used: 23:59:59.

Parameters

Returns

Formatted date

Pluf_DB_BooleanFromDb()

Pluf_DB_BooleanFromDb(  $val) 

Parameters

Pluf_DB_BooleanToDb()

Pluf_DB_BooleanToDb(  $val,   $db) 

Parameters

Pluf_DB_CompressedFromDb()

Pluf_DB_CompressedFromDb(  $val) 

Parameters

Pluf_DB_CompressedToDb()

Pluf_DB_CompressedToDb(  $val,   $db) 

Parameters

Pluf_DB_defaultTypecast()

Pluf_DB_defaultTypecast() : array

Returns an array of default typecast and quoting for the database ORM.

Foreach field type you need to provide an array with 2 functions, the from_db, the to_db.

$value = from_db($value); $escaped_value = to_db($value, $dbobject);

$escaped_value is ready to be put in the SQL, that is if this is a string, the value is quoted and escaped for example with SQLite: 'my string'' is escaped' or with MySQL 'my string\' is escaped' the starting ' and ending ' are included!

Returns

Default typecast.

Pluf_DB_Field_File_Path()

Pluf_DB_Field_File_Path(  $field,   $method,   $model,   $args = null) 

Returns the path to access the file.

Parameters

Pluf_DB_Field_File_Url()

Pluf_DB_Field_File_Url(  $field,   $method,   $model,   $args = null) 

Returns the url to access the file.

Parameters

Pluf_DB_FloatFromDb()

Pluf_DB_FloatFromDb(  $val) 

Parameters

Pluf_DB_FloatToDb()

Pluf_DB_FloatToDb(  $val,   $db) 

Parameters

Pluf_DB_GeometryFromDb()

Pluf_DB_GeometryFromDb(Object  $val) : string

Parameters

Returns

Pluf_DB_GeometryToDb()

Pluf_DB_GeometryToDb(\unknown  $val, \unknown  $db) : string

Convert text to geometry

Parameters

Returns

Pluf_DB_getConnection()

Pluf_DB_getConnection(  $extra = null) 

Get the default DB connection.

The default database connection is defined in the configuration file through the following configuration variables:

• db_login : Login to connect to the database
• db_password : Password to the database
• db_server : Name of the server
• db_database : Name of the database
• db_table_prefix : Prefix for the table names
• db_version : Version of the database engine
• db_engine : Engine for exampe 'MySQL', 'SQLite'

Once the first connection is created the following calls to Pluf::db() are getting the same connection.

Parameters

Pluf_DB_IdentityFromDb()

Pluf_DB_IdentityFromDb(  $val) : mixed

Identity function.

Parameters

Returns

Value

Pluf_DB_IdentityToDb()

Pluf_DB_IdentityToDb(  $val,   $db) : string

Identity function.

Parameters

Returns

Ready to use for SQL.

Pluf_DB_IntegerFromDb()

Pluf_DB_IntegerFromDb(  $val) 

Parameters

Pluf_DB_IntegerToDb()

Pluf_DB_IntegerToDb(  $val,   $db) 

Parameters

Pluf_DB_PasswordToDb()

Pluf_DB_PasswordToDb(  $val,   $db) 

Parameters

Pluf_DB_PostgreSQL_BooleanFromDb()

Pluf_DB_PostgreSQL_BooleanFromDb(  $val) 

Parameters

Pluf_DB_PostgreSQL_CompressedFromDb()

Pluf_DB_PostgreSQL_CompressedFromDb(  $val) 

Parameters

Pluf_DB_PostgreSQL_CompressedToDb()

Pluf_DB_PostgreSQL_CompressedToDb(  $val,   $con) 

Parameters

Pluf_DB_SerializedFromDb()

Pluf_DB_SerializedFromDb(  $val) 

Parameters

Pluf_DB_SerializedToDb()

Pluf_DB_SerializedToDb(  $val,   $db) 

Parameters

Pluf_DB_SlugToDB()

Pluf_DB_SlugToDB(  $val,   $db) 

Parameters

Pluf_DB_SQLite_CompressedToDb()

Pluf_DB_SQLite_CompressedToDb(  $val,   $con) 

Parameters

Pluf_esc()

Pluf_esc(  $string) : string

Shortcut needed all over the place.

Note that in some cases, we need to escape strings not in UTF-8, so this is not possible to safely use a call to htmlspecialchars. This is why str_replace is used.

Parameters

Returns

HTML escaped string

Pluf_Form_Field_File_moveToUploadFolder()

Pluf_Form_Field_File_moveToUploadFolder(  $value,   $params = array()) : string

Default move function. The file name is sanitized.

In the extra parameters, options can be used so that this function is matching most of the needs:

• 'upload_path': The path in which the uploaded file will be stored.

• 'upload_path_create': If set to true, try to create the upload path if not existing.

• 'upload_overwrite': Set it to true if you want to allow overwritting.

• 'file_name': Force the file name to this name and do not use the original file name. If this name contains '%s' for example 'myid-%s', '%s' will be replaced by the original filename. This can be used when for example, you want to prefix with the id of an article all the files attached to this article.

If you combine those options, you can dynamically generate the path name in your form (for example date base) and let this upload function create it on demand.

Parameters

Returns

Name relative to the upload path.

Pluf_Form_Widget_Attrs()

Pluf_Form_Widget_Attrs(  $attrs) 

Convert an array in a string ready to use for HTML attributes.

As all the widget will extend the Pluf_Form_Widget class, it means that this function is available directly in the extended class.

Parameters

Pluf_HTTP_handleMagicQuotes()

Pluf_HTTP_handleMagicQuotes(  $value) 

Break magic_quotes

Parameters

Pluf_HTTP_magicStrip()

Pluf_HTTP_magicStrip(  $k,   $key) 

Break magic_quotes

Parameters

Pluf_HTTP_Response_ServerErrorDebug_Pretty()

Pluf_HTTP_Response_ServerErrorDebug_Pretty(  $e) 

Parameters

Pluf_Log_assert()

Pluf_Log_assert(  $file,   $line,   $code) 

Assertion handler.

Parameters

Pluf_Model_InArray()

Pluf_Model_InArray(  $model,   $array) : boolean

Check if a model is already in an array of models.

It is not possible to override the == function in PHP to directly use in_array.

Parameters

Returns

Pluf_Model_RemoveDuplicates()

Pluf_Model_RemoveDuplicates(  $array) : array

Return a list of unique models.

Parameters

Returns

Models with duplicates.

Pluf_Shortcuts_folderSize()

Pluf_Shortcuts_folderSize(string  $dir) : \number

Compute folder size

Parameters

Returns

Pluf_Shortcuts_GetAssociationTableName()

Pluf_Shortcuts_GetAssociationTableName(string  $modelName1, string  $modelName2) : string

Returns association table name (without prefix) for given models.

Parameters

Returns

name of association table for given modeles.

Pluf_Shortcuts_GetForeignKeyName()

Pluf_Shortcuts_GetForeignKeyName(string  $modelName) : string

Returns column name for given model as foreign key in an association table.

Parameters

Returns

column name for given model as foreign key in an association table.

Pluf_Shortcuts_GetFormForModel()

Pluf_Shortcuts_GetFormForModel(  $model,   $data = null,   $extra = array(),   $label_suffix = null) : \Pluf_Form_Model

Get a given form from a model.

Parameters

Returns

Form for this model.

Pluf_Shortcuts_GetFormForUpdateModel()

Pluf_Shortcuts_GetFormForUpdateModel(  $model,   $data = null,   $extra = array(),   $label_suffix = null) : Object

Get a given form from a model to update.

Parameters

Returns

Form to update for this model.

Pluf_Shortcuts_GetListCount()

Pluf_Shortcuts_GetListCount(\Pluf_HTTP_Request  $request) : \number

Returns list count for given request.

If count is not set in request or count is more than a threshold (50) returns a default value (50).

Parameters

Returns

Pluf_Shortcuts_GetObjectOr404()

Pluf_Shortcuts_GetObjectOr404(  $object,   $id) : \Pluf_Model

Get an object by id or raise a 404 error.

Parameters

Returns

The found object.

Pluf_Shortcuts_GetOneOr404()

Pluf_Shortcuts_GetOneOr404(  $object,   $bsql,   $psql) : Object

Get an object by SQL or raise a 404 error.

Usage:

$obj = Pluf_Shortcuts_GetOneOr404('MyApp_Model',
'path=%s AND status=%s',
array('welcome', 1));

Parameters

Returns

The found object

Pluf_Shortcuts_GetRequestParam()

Pluf_Shortcuts_GetRequestParam(  $request,   $id) 

Parameters

Pluf_Shortcuts_GetRequestParamOr403()

Pluf_Shortcuts_GetRequestParamOr403(  $request,   $id)