Permalink
Browse files

phpdoc fixes

  • Loading branch information...
flack committed Jan 9, 2018
1 parent 53b4dc1 commit fec0155f18cb9f087751e04199193b25a6ba6ee1
@@ -177,7 +177,7 @@ private function _jpegtran_available()
*
* @todo Use ImageMagick Identify to check for a valid image.
*
* @param string filename The file to be edited.
* @param string $filename The file to be edited.
* @return boolean true, if the file is valid, false otherwise.
*/
public function set_file($filename)
@@ -217,7 +217,7 @@ public function get_file()
*
* Processing stops as soon as one filter command fails.
*
* @param string chain The filter chain to be processed (filter1();filter2();...)
* @param string $chain The filter chain to be processed (filter1();filter2();...)
*/
public function process_chain($chain)
{
@@ -238,7 +238,7 @@ public function process_chain($chain)
* All filters will use defaults for missing arguments (which can
* result in a null operation) and will ignore excessive arguments.
*
* @param string cmd The command to be executed.
* @param string $cmd The command to be executed.
*/
function process_command($cmd)
{
@@ -304,8 +304,8 @@ public static function fix_serialization($data)
* Returns the first instance of a given component on the site.
*
* @param string $component The component name
* @param integer Node ID of parent topic
* @param midcom_helper_nav $nap $use_cache Should the in-memory cache be used
* @param integer $node_id Node ID of parent topic
* @param midcom_helper_nav $nap
* @return array NAP array of the first component instance found
*/
public static function find_node_by_component($component, $node_id = null, midcom_helper_nav $nap = null)
@@ -312,8 +312,8 @@ public function add_items(array $items, $before = -1)
* Add an item to another item by either adding the item to the MIDCOM_TOOLBAR_SUBMENU
* or creating a new subtoolbar and adding the item there.
*
* @param array item
* @param int toolbar itemindex.
* @param array $item
* @param int $index toolbar item index.
* @return boolean false if insert failed.
*/
public function add_item_to_index($item, $index)
@@ -337,7 +337,7 @@ public function add_item_to_index($item, $index)
* Clean up an item that is added, making sure that the item has all the
* needed options and indexes.
*
* @param array the item to be cleaned
* @param array $item the item to be cleaned
* @return array the cleaned item.
*/
public function clean_item($item)
@@ -142,7 +142,7 @@ public function get_page_class($context_id = null)
* - hidden: object is hidden via metadata settings or scheduling
*
* @param midcom_core_dbaobject $object The DBA class instance to get CSS classes for
* @param string Existing CSS classes to append to
* @param string $existing_classes Existing CSS classes to append to
* @return string CSS classes for that object
*/
public function get_object_classes($object, $existing_classes = null)
@@ -71,8 +71,8 @@ public function update($object, $updatemessage = null)
* Should be called just before $object->update(), if the type parameter is omitted
* the function will use GUID to determine the type, this makes an extra DB query.
*
* @param string root of rcs directory.
* @param object object to be updated.
* @param object $object to be updated.
* @param string $message
* @return int :
* 0 on success
* 3 on missing object->guid
@@ -108,7 +108,7 @@ public function rcs_update($object, $message)
/**
* Get the object of a revision
*
* @param string revision identifier of revision wanted
* @param string $revision identifier of revision wanted
* @return array array representation of the object
*/
public function get_revision($revision)
@@ -136,7 +136,7 @@ public function get_revision($revision)
/**
* Check if a revision exists
*
* @param string version
* @param string $version
* @return boolean true if exists
*/
public function version_exists($version)
@@ -148,7 +148,7 @@ public function version_exists($version)
/**
* Get the previous versionID
*
* @param string version
* @param string $version
* @return string versionid before this one or empty string.
*/
public function get_prev_version($version)
@@ -176,7 +176,7 @@ public function get_previous_version($version)
/**
* Get the next versionID
*
* @param string version
* @param string $version
* @return string versionid before this one or empty string.
*/
public function get_next_version($version)
@@ -275,7 +275,7 @@ private function rcs_parse_history_entry($entry)
/**
* Get a list of the object's history
*
* @param string objectid (usually the guid)
* @param string $what objectid (usually the guid)
* @return array list of revisions and revision comment.
*/
private function rcs_gethistory($what)
@@ -343,7 +343,7 @@ private function rcs_writefile($guid, $data)
/**
* Reads data from file $guid and returns it.
*
* @param string guid
* @param string $guid
* @return string xml representation of guid
*/
private function rcs_readfile($guid)
@@ -431,8 +431,8 @@ private function exec($command, $use_rcs_bindir = true)
/**
* Get a html diff between two versions.
*
* @param string latest_revision id of the latest revision
* @param string oldest_revision id of the oldest revision
* @param string $oldest_revision id of the oldest revision
* @param string $latest_revision id of the latest revision
* @return array array with the original value, the new value and a diff -u
*/
public function get_diff($oldest_revision, $latest_revision, $renderer_style = 'inline')
@@ -492,7 +492,7 @@ public function get_diff($oldest_revision, $latest_revision, $renderer_style = '
/**
* Get the comment of one revision.
*
* @param string revison id
* @param string $revision id
* @return string comment
*/
public function get_comment($revision)
@@ -504,7 +504,7 @@ public function get_comment($revision)
/**
* Restore an object to a certain revision.
*
* @param string id of revision to restore object to.
* @param string $revision of revision to restore object to.
* @return boolean true on success.
*/
public function restore_to_revision($revision)
@@ -405,10 +405,10 @@ public static function get_tags()
/**
* Gets all objects of given classes with given tags
*
* @param array of tags to search for
* @param array of classes to search in
* @param string AND or OR, depending if you require all of the given tags on any of them, defaults to 'OR'
* @param string ASC or DESC, to set the order of the returned list, defaults to 'ASC'
* @param array $tags tags to search for
* @param array $classes classes to search in
* @param string $match AND or OR, depending if you require all of the given tags on any of them, defaults to 'OR'
* @param string $order ASC or DESC, to set the order of the returned list, defaults to 'ASC'
* @return array of objects or false on critical failure
*/
public static function get_objects_with_tags(array $tags, array $classes, $match = 'OR', $order = 'ASC')
@@ -134,7 +134,7 @@ public function _show_user_events($handler_id, array &$data)
*
* Returns full object or false in case of failure.
*
* @param string username
* @param string $username
* @return org_openpsa_contacts_person_dba person
*/
private function _find_person_by_name($username)
@@ -104,8 +104,8 @@ private function add_constraint(midcom_core_query $query, midcom_core_dbaobject
/**
* Calculates P for the given two persons being duplicates
*
* @param array person1
* @param array person2
* @param array $person1
* @param array $person2
* @return array with overall P and matched checks
*/
function p_duplicate_person(array $person1, array $person2)
@@ -259,8 +259,8 @@ private function get_group_candidates(org_openpsa_contacts_group_dba $group = nu
/**
* Calculates P for the given two persons being duplicates
*
* @param array group1
* @param array group2
* @param array $group1
* @param array $group2
* @return array with overall P and matched checks
*/
function p_duplicate_group(array $group1, array $group2)
@@ -23,7 +23,8 @@ class org_openpsa_contacts_duplicates_merge
/**
* Constructor, the parameter governs which objects the instance works on
* @param string mode, currently valid modes are 'person' and 'group'
*
* @param string $mode currently valid modes are 'person' and 'group'
*/
public function __construct($mode, midcom_helper_configuration $config)
{
@@ -32,7 +32,7 @@ public function add_member_constraints($qb);
* Validate results before send
*
* @param array &$results Array of member objects
* @param boolean Indicating success
* @return boolean Indicating success
*/
public function check_results(array &$results);
@@ -57,7 +57,7 @@ public function add_member_constraints($qb)
* Validate results before send
*
* @param array $results Array of member objects
* @param boolean Indicating success
* @return boolean Indicating success
*/
public function check_results(array &$results)
{
@@ -215,7 +215,7 @@ public function generate_safe_password($length = 0)
/**
* Function to check if passed password was already used
*
* @param string password to check
* @param string $password Password to check
* @return bool returns if password was already used - true indicates passed password wasn't used
*/
function check_password_reuse($password)

0 comments on commit fec0155

Please sign in to comment.